.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONETEMPLATE" "1" "October 2016" "" "onetemplate(1) -- manages OpenNebula templates"
.
.SH "NAME"
\fBonetemplate\fR \- manages OpenNebula templates
.
.SH "SYNOPSIS"
\fBonetemplate\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf

 \-\-name name               Name of the new VM or TEMPLATE\. When
                           instantiating multiple VMs you can use the "%i"
                           wildcard to produce different names such as
                           vm\-0, vm\-1\.\.\.
 \-\-cpu cpu                 CPU percentage reserved for the VM (1=100% one
                           CPU)
 \-\-vcpu vcpu               Number of virtualized CPUs
 \-\-arch arch               Architecture of the VM, e\.g\.: i386 or x86_64
 \-\-memory memory           Memory amount given to the VM\. By default the
                           unit is megabytes\. To use gigabytes add a \'g\',
                           floats can be used: 8g=8192, 0\.5g=512
 \-\-disk image0,image1      Disks to attach\. To use an image owned by other
                           user use user[disk]\. Add any additional
                           attributes separated by \':\' and in the shape of
                           KEY=VALUE\. For example, if the disk must be
                           resized, use image0:size=1000 \. Or
                           image0:size=1000:target=vda,image1:target=vdb
 \-\-nic network0,network1   Networks to attach\. To use a network owned by
                           other user use user[network]\. Additional
                           attributes are supported like with the \-\-disk
                           option\.
 \-\-raw string              Raw string to add to the template\. Not to be
                           confused with the RAW attribute
 \-\-vnc                     Add VNC server to the VM
 \-\-vnc\-password password   VNC password
 \-\-vnc\-listen ip           VNC IP where to listen for connections\. By
                           default is 0\.0\.0\.0 (all interfaces)\.
 \-\-vnc\-keymap keymap       VNC keyboard layout
 \-\-spice                   Add spice server to the VM
 \-\-spice\-password password spice password
 \-\-spice\-listen ip         spice IP where to listen for connections\. By
                           default is 0\.0\.0\.0 (all interfaces)\.
 \-\-spice\-keymap keymap     spice keyboard layout
 \-\-ssh [file]              Add an ssh public key to the context\. If the file
                           is omited then the user variable SSH_PUBLIC_KEY
                           will be used\.
 \-\-net_context             Add network contextualization parameters
 \-\-context line1,line2,line3 Lines to add to the context section
 \-\-boot device_list        Set boot device list e\.g\. disk0,disk2,nic0
 \-\-files_ds file1,file2    Add files to the contextualization CD from
                           thefiles datastore
 \-\-init script1,script2    Script or scripts to start in context
 \-\-startscript [file]      Start script to be executed
 \-\-report_ready            Sends READY=YES to OneGate, useful for OneFlow
 \-\-dry                     Just print the template
 \-\-recursive               Applies the action to the template plus any image
                           defined in DISK
 \-m, \-\-multiple x          Instance multiple VMs
 \-\-userdata userdata       Integrate userdata into the EC2 section
 \-\-hold                    Creates the new VM on hold state instead of
                           pending
 \-\-persistent              Creates a private persistent copy of the template
                           plus any image defined in DISK, and instantiates
                           that copy
 \-a, \-\-append              Append new attributes to the current template
 \-l, \-\-list x,y,z          Selects columns to display with list command
 \-c, \-\-listconf conf       Selects a predefined column list
 \-d, \-\-delay x             Sets the delay in seconds for top command
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
                           column=value pairs\.
 \-\-csv                     Write table in csv format
 \-x, \-\-xml                 Show the resource in xml format
 \-n, \-\-numeric             Do not translate user and group IDs
 \-\-describe                Describe list columns
 \-\-extended                Process the template and included extended
                           information, such as the SIZE for each DISK
 \-v, \-\-verbose             Verbose mode
 \-h, \-\-help                Show this message
 \-V, \-\-version             Show version and copyright information
 \-\-user name               User name used to connect to OpenNebula
 \-\-password password       Password to authenticate with OpenNebula
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIfile\fR] Creates a new VM Template from the given description
.
.IP "" 4
.
.nf

Examples:
  \- using a VM Template description file:

    onetemplate create vm_description\.tmpl

  \- new VM Template named "arch vm" with a disk and a nic:

    onetemplate create \-\-name "arch vm" \-\-memory 128 \-\-cpu 1 \e
                       \-\-disk arch \-\-network private_lan

  \- using two disks:

    onetempate create \-\-name "test vm" \-\-memory 128 \-\-cpu 1 \e
                      \-\-disk arch,data
valid options: name, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, dry
.
.fi
.
.IP "" 0

.
.IP "\(bu" 4
clone \fItemplateid\fR \fIname\fR Creates a new Template from an existing one valid options: recursive
.
.IP "\(bu" 4
delete \fIrange|templateid_list\fR Deletes the given Template valid options: recursive
.
.IP "\(bu" 4
instantiate \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command\.
.
.IP "" 4
.
.nf

The source Template can be modified adding or replacing attributes with
the optional file argument, or with the options\.
valid options: name, multiple, userdata, hold, persistent, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready
.
.fi
.
.IP "" 0

.
.IP "\(bu" 4
chgrp \fIrange|templateid_list\fR \fIgroupid\fR Changes the Template group
.
.IP "\(bu" 4
chown \fIrange|templateid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Template owner and group
.
.IP "\(bu" 4
chmod \fIrange|templateid_list\fR \fIoctet\fR Changes the Template permissions valid options: recursive
.
.IP "\(bu" 4
update \fItemplateid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
rename \fItemplateid\fR \fIname\fR Renames the Template
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists Templates in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fItemplateid\fR Shows information for the given Template valid options: xml, extended
.
.IP "\(bu" 4
top [\fIfilterflag\fR] Lists Templates continuously valid options: list, listconf, delay, filter, csv, xml, numeric, describe
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
templateid OpenNebula VMTEMPLATE name or id
.
.IP "\(bu" 4
templateid_list Comma\-separated list of OpenNebula VMTEMPLATE names or ids
.
.IP "\(bu" 4
filterflag a, all all the known VMTEMPLATEs m, mine the VMTEMPLATE belonging to the user in ONE_AUTH g, group \'mine\' plus the VMTEMPLATE belonging to the groups the user is member of uid VMTEMPLATE of the user identified by this uid user VMTEMPLATE of the user identified by the username
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 5\.2\.0 Copyright 2002\-2016, OpenNebula Project, OpenNebula Systems
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0
